Skip to content

Conversation

@munapower
Copy link
Contributor

What this PR does / why we need it:
It improves the readibility of the repo information.
Which issue(s) this PR fixes:

Fixes #734

Special notes for your reviewer:

Does this PR introduce a user-facing changes and/or breaks backward compatability?:

Yes, it enhances the structure of the Readme so it is easier to follow.

@munapower munapower linked an issue Jan 14, 2025 that may be closed by this pull request
@munapower munapower added the documentation This contains documentation/description/comments label Jan 14, 2025
@munapower
Copy link
Contributor Author

@anshikavashistha can you help here?

@munapower munapower self-assigned this Mar 24, 2025
Copy link
Contributor

@mbrandenburger mbrandenburger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Maria! I've added a few changes to fix the heading. Each document SHOULD be considered as independent, thus, they can all start with H1 header :)

Copy link
Contributor

@mbrandenburger mbrandenburger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@munapower munapower marked this pull request as ready for review March 31, 2025 13:53
@munapower munapower requested a review from a team as a code owner March 31, 2025 13:53
Signed-off-by: munapower <mmunaro@hotmail.com>

correct links to setup

Signed-off-by: munapower <mmunaro@hotmail.com>

moving architecture design

Signed-off-by: munapower <mmunaro@hotmail.com>

moved reference guides, troubleshooting and build sgx

Signed-off-by: munapower <mmunaro@hotmail.com>

nonsgx playground

Signed-off-by: munapower <mmunaro@hotmail.com>

update samples readme and fix main readme

Signed-off-by: munapower <mmunaro@hotmail.com>

fix readme

Signed-off-by: munapower <mmunaro@hotmail.com>

add playground nonsgx doc

Signed-off-by: munapower <mmunaro@hotmail.com>

fixed links to other pages or sections

Signed-off-by: munapower <mmunaro@hotmail.com>

correct link errprs

Signed-off-by: munapower <mmunaro@hotmail.com>

Apply suggestions from code review

Signed-off-by: Marcus Brandenburger <mbrandenburger@users.noreply.github.com>

Update samples/README.md

Signed-off-by: Marcus Brandenburger <mbrandenburger@users.noreply.github.com>
@munapower munapower force-pushed the 734-restructure-readme branch from 816fe49 to b271733 Compare April 1, 2025 14:42
@mbrandenburger mbrandenburger merged commit 7f07b9a into hyperledger:main Apr 1, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This contains documentation/description/comments

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Restructure Readme to more of a tree like approach

2 participants